/*! \file bcmcnet_main.h
 *
 * BCMCNET data structure and APIs.
 */
/*
 * Copyright: (c) 2018 Broadcom. All Rights Reserved. "Broadcom" refers to 
 * Broadcom Limited and/or its subsidiaries.
 * 
 * Broadcom Switch Software License
 * 
 * This license governs the use of the accompanying Broadcom software. Your 
 * use of the software indicates your acceptance of the terms and conditions 
 * of this license. If you do not agree to the terms and conditions of this 
 * license, do not use the software.
 * 1. Definitions
 *    "Licensor" means any person or entity that distributes its Work.
 *    "Software" means the original work of authorship made available under 
 *    this license.
 *    "Work" means the Software and any additions to or derivative works of 
 *    the Software that are made available under this license.
 *    The terms "reproduce," "reproduction," "derivative works," and 
 *    "distribution" have the meaning as provided under U.S. copyright law.
 *    Works, including the Software, are "made available" under this license 
 *    by including in or with the Work either (a) a copyright notice 
 *    referencing the applicability of this license to the Work, or (b) a copy 
 *    of this license.
 * 2. Grant of Copyright License
 *    Subject to the terms and conditions of this license, each Licensor 
 *    grants to you a perpetual, worldwide, non-exclusive, and royalty-free 
 *    copyright license to reproduce, prepare derivative works of, publicly 
 *    display, publicly perform, sublicense and distribute its Work and any 
 *    resulting derivative works in any form.
 * 3. Grant of Patent License
 *    Subject to the terms and conditions of this license, each Licensor 
 *    grants to you a perpetual, worldwide, non-exclusive, and royalty-free 
 *    patent license to make, have made, use, offer to sell, sell, import, and 
 *    otherwise transfer its Work, in whole or in part. This patent license 
 *    applies only to the patent claims licensable by Licensor that would be 
 *    infringed by Licensor's Work (or portion thereof) individually and 
 *    excluding any combinations with any other materials or technology.
 *    If you institute patent litigation against any Licensor (including a 
 *    cross-claim or counterclaim in a lawsuit) to enforce any patents that 
 *    you allege are infringed by any Work, then your patent license from such 
 *    Licensor to the Work shall terminate as of the date such litigation is 
 *    filed.
 * 4. Redistribution
 *    You may reproduce or distribute the Work only if (a) you do so under 
 *    this License, (b) you include a complete copy of this License with your 
 *    distribution, and (c) you retain without modification any copyright, 
 *    patent, trademark, or attribution notices that are present in the Work.
 * 5. Derivative Works
 *    You may specify that additional or different terms apply to the use, 
 *    reproduction, and distribution of your derivative works of the Work 
 *    ("Your Terms") only if (a) Your Terms provide that the limitations of 
 *    Section 7 apply to your derivative works, and (b) you identify the 
 *    specific derivative works that are subject to Your Terms. 
 *    Notwithstanding Your Terms, this license (including the redistribution 
 *    requirements in Section 4) will continue to apply to the Work itself.
 * 6. Trademarks
 *    This license does not grant any rights to use any Licensor's or its 
 *    affiliates' names, logos, or trademarks, except as necessary to 
 *    reproduce the notices described in this license.
 * 7. Limitations
 *    Platform. The Work and any derivative works thereof may only be used, or 
 *    intended for use, with a Broadcom switch integrated circuit.
 *    No Reverse Engineering. You will not use the Work to disassemble, 
 *    reverse engineer, decompile, or attempt to ascertain the underlying 
 *    technology of a Broadcom switch integrated circuit.
 * 8. Termination
 *    If you violate any term of this license, then your rights under this 
 *    license (including the license grants of Sections 2 and 3) will 
 *    terminate immediately.
 * 9. Disclaimer of Warranty
 *    THE WORK IS PROVIDED "AS IS" WITHOUT WARRANTIES OR CONDITIONS OF ANY 
 *    KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WARRANTIES OR CONDITIONS OF 
 *    MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE OR 
 *    NON-INFRINGEMENT. YOU BEAR THE RISK OF UNDERTAKING ANY ACTIVITIES UNDER 
 *    THIS LICENSE. SOME STATES' CONSUMER LAWS DO NOT ALLOW EXCLUSION OF AN 
 *    IMPLIED WARRANTY, SO THIS DISCLAIMER MAY NOT APPLY TO YOU.
 * 10. Limitation of Liability
 *    EXCEPT AS PROHIBITED BY APPLICABLE LAW, IN NO EVENT AND UNDER NO LEGAL 
 *    THEORY, WHETHER IN TORT (INCLUDING NEGLIGENCE), CONTRACT, OR OTHERWISE 
 *    SHALL ANY LICENSOR BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY DIRECT, 
 *    INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF 
 *    OR RELATED TO THIS LICENSE, THE USE OR INABILITY TO USE THE WORK 
 *    (INCLUDING BUT NOT LIMITED TO LOSS OF GOODWILL, BUSINESS INTERRUPTION, 
 *    LOST PROFITS OR DATA, COMPUTER FAILURE OR MALFUNCTION, OR ANY OTHER 
 *    COMMERCIAL DAMAGES OR LOSSES), EVEN IF THE LICENSOR HAS BEEN ADVISED OF 
 *    THE POSSIBILITY OF SUCH DAMAGES.
 */

#ifndef BCMCNET_MAIN_H
#define BCMCNET_MAIN_H

#include <bcmpkt/bcmpkt_buf.h>
#include <bcmcnet/bcmcnet_types.h>

/*! Maximum number of PDMA devices supported */
#define NUM_PDMA_DEV_MAX        BCMDRD_CONFIG_MAX_UNITS

/*! Maximum number of Rx callbacks */
#define NUM_RX_CB_MAX           8

/*!
 * \brief Device configure structure.
 */
typedef struct bcmcnet_dev_cfg_s {
    /*! Device name */
    char name[DEV_NAME_LEN_MAX];

    /*! Device type string */
    char type_str[DEV_NAME_LEN_MAX];

    /*! Device ID */
    uint32_t dev_id;

    /*! Reserved */
    uint32_t rsvd;

    /*! Number of groups */
    uint32_t nb_grp;

    /*! Bitmap of groups */
    uint32_t bm_grp;
} bcmcnet_dev_cfg_t;

/*!
 * \brief Channel configure structure.
 */
typedef struct bcmcnet_chan_cfg_s {
    /*! Channel number */
    int chan;

    /*! Number of descriptors */
    uint32_t nb_desc;

    /*! Rx buffer size */
    uint32_t rx_buf_size;

    /*! Channel control */
    uint32_t chan_ctrl;
    /*! Packet_byte_swap */
#define BCMCNET_PKT_BYTE_SWAP   (1 << 0)
    /*! Non packet_byte_swap */
#define BCMCNET_OTH_BYTE_SWAP   (1 << 1)
    /*! Header_byte_swap */
#define BCMCNET_HDR_BYTE_SWAP   (1 << 2)

    /*! Rx or Tx */
    int dir;
    /*! Rx channel */
#define BCMCNET_RX_CHAN         PDMA_Q_RX
    /*! Tx channel */
#define BCMCNET_TX_CHAN         PDMA_Q_TX
} bcmcnet_chan_cfg_t;

/*!
 * \brief RCPU header structure.
 */
struct bcmcnet_rcpu_hdr {
    /*! Destination MAC address */
    uint8_t dst_mac[6];

    /*! Source MAC address */
    uint8_t src_mac[6];

    /*! VLAN TPID */
    uint16_t vlan_tpid;

    /*! VLAN TCI */
    uint16_t vlan_tci;

    /*! Ethernet type */
    uint16_t eth_type;

    /*! Packet signature */
    uint16_t pkt_sig;

    /*! Operation code */
    uint8_t op_code;

    /*! Flags */
    uint8_t flags;

    /*! Transaction number */
    uint16_t trans_id;

    /*! Packet data length */
    uint16_t data_len;

    /*! Expected data length */
    uint16_t rep_len;

    /*! Packet meta data length */
    uint8_t meta_len;

    /*! Transmission queue number */
    uint8_t queue_id;

    /*! Reserved must be 0 */
    uint16_t reserved;
};

/*! RCPU Rx operation */
#define RCPU_OPCODE_RX          0x10
/*! RCPU Tx operation */
#define RCPU_OPCODE_TX          0x20

/*! RCPU purge flag */
#define RCPU_FLAG_PURGE         (1 << 0)
/*! RCPU pause flag */
#define RCPU_FLAG_PAUSE         (1 << 1)
/*! RCPU modhdr flag */
#define RCPU_FLAG_MODHDR        (1 << 2)
/*! RCPU bind queue flag */
#define RCPU_FLAG_BIND_QUE      (1 << 3)

/*! Function type for RX packet processing callbacks */
typedef int (*bcmcnet_rx_cb_t)(int unit, int queue, bcmpkt_data_buf_t *buf, void *ck);

/*!
 * \brief Callbacks information structure.
 */
typedef struct bcmcnet_rx_cbs_s {
    /*! Callback */
    bcmcnet_rx_cb_t cb;

    /*! Callback parameter */
    void *ck;
} bcmcnet_rx_cbs_t;

/*!
 * \brief Initialize the core networking subsystem.
 *
 * \param [in] unit Device number.
 * \param [in] dev_cfg Device configure structure point.
 *
 * \retval SHR_E_NONE No errors.
 * \retval SHR_E_XXXX Operation failed.
 */
extern int
bcmcnet_dev_init(int unit, bcmcnet_dev_cfg_t *dev_cfg);

/*!
 * \brief Clean up the core networking subsystem.
 *
 * \param [in] unit Device number.
 *
 * \retval SHR_E_NONE No errors.
 * \retval SHR_E_XXXX Operation failed.
 */
extern int
bcmcnet_dev_cleanup(int unit);

/*!
 * \brief Configure the core networking subsystem channel.
 *
 * \param [in] unit Device number.
 * \param [in] chan_cfg Channel configure structure point.
 *
 * \retval SHR_E_NONE No errors.
 * \retval SHR_E_XXXX Operation failed.
 */
extern int
bcmcnet_dev_chan_config(int unit, bcmcnet_chan_cfg_t *chan_cfg);

/*!
 * \brief Query the core networking subsystem channel.
 *
 * \param [in] unit Device number.
 * \param [in] chan_cfg Channel configure structure point.
 *
 * \retval SHR_E_NONE No errors.
 * \retval SHR_E_XXXX Operation failed.
 */
extern int
bcmcnet_dev_chan_query(int unit, bcmcnet_chan_cfg_t *chan_cfg);

/*!
 * \brief Start the core networking subsystem.
 *
 * \param [in] unit Device number.
 *
 * \retval SHR_E_NONE No errors.
 * \retval SHR_E_XXXX Operation failed.
 */
extern int
bcmcnet_dev_start(int unit);

/*!
 * \brief Stop the core networking subsystem.
 *
 * \param [in] unit Device number.
 *
 * \retval SHR_E_NONE No errors.
 * \retval SHR_E_XXXX Operation failed.
 */
extern int
bcmcnet_dev_stop(int unit);

/*!
 * \brief Suspend the core networking subsystem.
 *
 * \param [in] unit Device number.
 *
 * \retval SHR_E_NONE No errors.
 * \retval SHR_E_XXXX Operation failed.
 */
extern int
bcmcnet_dev_suspend(int unit);

/*!
 * \brief Resume the core networking subsystem.
 *
 * \param [in] unit Device number.
 *
 * \retval SHR_E_NONE No errors.
 * \retval SHR_E_XXXX Operation failed.
 */
extern int
bcmcnet_dev_resume(int unit);

/*!
 * \brief Register callback.
 *
 * \param [in] unit Device number.
 * \param [in] cb Callback.
 * \param [in] ck Callback parameter.
 *
 * \retval SHR_E_NONE No errors.
 * \retval SHR_E_XXXX Operation failed.
 */
extern int
bcmcnet_rx_cb_register(int unit, bcmcnet_rx_cb_t cb, void *ck);

/*!
 * \brief Unregister callback.
 *
 * \param [in] unit Device number.
 * \param [in] cb Callback.
 * \param [in] ck Callback parameter.
 *
 * \retval SHR_E_NONE No errors.
 * \retval SHR_E_XXXX Operation failed.
 */
extern int
bcmcnet_rx_cb_unregister(int unit, bcmcnet_rx_cb_t cb, void *ck);

/*!
 * \brief Sent a Tx packet to the the core networking subsystem.
 *
 * \param [in] unit Device number.
 * \param [in] queue Tx queue.
 * \param [in] buf Tx packet buffer point.
 *
 * \retval SHR_E_NONE No errors.
 * \retval SHR_E_XXXX Operation failed.
 */
extern int
bcmcnet_tx(int unit, int queue, bcmpkt_data_buf_t *buf);

/*!
 * \brief Get the core networking subsystem information.
 *
 * \param [in] unit Device number.
 * \param [in] info Device information structure point.
 *
 * \retval SHR_E_NONE No errors.
 * \retval SHR_E_XXXX Operation failed.
 */
extern int
bcmcnet_dev_info_get(int unit, struct bcmcnet_dev_info **info);

/*!
 * \brief Get the kernel networking subsystem stats.
 *
 * \param [in] unit Device number.
 * \param [in] stats Device stats structure point.
 *
 * \retval SHR_E_NONE No errors.
 * \retval SHR_E_XXXX Operation failed.
 */
extern int
bcmcnet_dev_stats_get(int unit, struct bcmcnet_dev_stats **stats);

/*!
 * \brief Reset the kernel networking subsystem stats.
 *
 * \param [in] unit Device number.
 *
 * \retval SHR_E_NONE No errors.
 * \retval SHR_E_XXXX Operation failed.
 */
int bcmcnet_dev_stats_reset(int unit);

#endif /* BCMCNET_MAIN_H */

